home *** CD-ROM | disk | FTP | other *** search
/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / developer_install / CEGUISDK-0.4.1-VC6-Native.exe / {app} / include / elements / CEGUIProgressBarProperties.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-07-21  |  3.0 KB  |  99 lines
  1. /************************************************************************
  2.     filename:     CEGUIProgressBarProperties.h
  3.     created:    10/7/2004
  4.     author:        Paul D Turner
  5.     
  6.     purpose:    Interface to properties for the ProgressBar class
  7. *************************************************************************/
  8. /*************************************************************************
  9.     Crazy Eddie's GUI System (http://www.cegui.org.uk)
  10.     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
  11.  
  12.     This library is free software; you can redistribute it and/or
  13.     modify it under the terms of the GNU Lesser General Public
  14.     License as published by the Free Software Foundation; either
  15.     version 2.1 of the License, or (at your option) any later version.
  16.  
  17.     This library is distributed in the hope that it will be useful,
  18.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20.     Lesser General Public License for more details.
  21.  
  22.     You should have received a copy of the GNU Lesser General Public
  23.     License along with this library; if not, write to the Free Software
  24.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25. *************************************************************************/
  26. #ifndef _CEGUIProgressBarProperties_h_
  27. #define _CEGUIProgressBarProperties_h_
  28.  
  29. #include "CEGUIProperty.h"
  30.  
  31.  
  32. // Start of CEGUI namespace section
  33. namespace CEGUI
  34. {
  35.  
  36. // Start of ProgressBarProperties namespace section
  37. /*!
  38. \brief
  39.     Namespace containing all classes that make up the properties interface for the ProgressBar class
  40. */
  41. namespace ProgressBarProperties
  42. {
  43. /*!
  44. \brief
  45.     Property to access the current progress of the progress bar.
  46.  
  47.     \par Usage:
  48.         - Name: CurrentProgress
  49.         - Format: "[float]".
  50.  
  51.     \par Where:
  52.         - [float] is the current progress of the bar expressed as a value between 0 and 1.
  53. */
  54. class CurrentProgress : public Property
  55. {
  56. public:
  57.     CurrentProgress() : Property(
  58.         "CurrentProgress",
  59.         "Property to get/set the current progress of the progress bar.  Value is a float  value between 0.0 and 1.0 specifying the progress.",
  60.         "0.000000")
  61.     {}
  62.  
  63.     String    get(const PropertyReceiver* receiver) const;
  64.     void    set(PropertyReceiver* receiver, const String& value);
  65. };
  66.  
  67.  
  68. /*!
  69. \brief
  70.     Property to access the step size setting for the progress bar.
  71.  
  72.     \par Usage:
  73.         - Name: StepSize
  74.         - Format: "[float]".
  75.  
  76.     \par Where:
  77.         - [float] is the size of the invisible sizing border in screen pixels.
  78. */
  79. class StepSize : public Property
  80. {
  81. public:
  82.     StepSize() : Property(
  83.         "StepSize",
  84.         "Property to get/set the step size setting for the progress bar.  Value is a float value.",
  85.         "0.010000")
  86.     {}
  87.  
  88.     String    get(const PropertyReceiver* receiver) const;
  89.     void    set(PropertyReceiver* receiver, const String& value);
  90. };
  91.  
  92.  
  93. } // End of  ProgressBarProperties namespace section
  94.  
  95. } // End of  CEGUI namespace section
  96.  
  97.  
  98. #endif    // end of guard _CEGUIProgressBarProperties_h_
  99.